home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / doors_1 / crypto17.zip / CRYPTO.DOC < prev    next >
Text File  |  1992-09-22  |  20KB  |  436 lines

  1.  
  2.                               CRYPTOGRAMS
  3.  
  4.                                   v1.7
  5.  
  6.                                    by
  7.  
  8.                               Al Lawrence
  9.  
  10.                             Sunrise-80  BBS
  11.                             (404) 256-9525
  12.  
  13.  
  14.  
  15.  
  16.                                 OVERVIEW
  17.                                 ________
  18.  
  19.  
  20.    In CRYPTOGRAMS you must solve a coded phrase. It is played exactly like
  21.    the puzzle games of the same name, that appear in magazines and newspapers.
  22.    It is very difficult to solve and requires a lot of patience.
  23.  
  24.  
  25.    NOTE: Most errors will be logged to a file called DFRAME.ERR which is
  26.          created in the directory you run the door from.
  27.  
  28.  
  29.  
  30.                               INSTALLATION
  31.                               ____________
  32.  
  33.  
  34.    Installation is fairly easy and straight-forward. The following steps and
  35.    examples should have you up and running in a very short period of time.
  36.    It is assumed that you are familiar with setting up DOORS on your system.
  37.    To this end, only examples of the configuration file and Door batch file
  38.    are described.
  39.  
  40.       1) Create a directory to hold all CRYPTO files
  41.  
  42.       2) Unzip CRYPTOxx.ZIP into the the above directory
  43.  
  44.          NOTE: BRUN45.EXE is not included but is required !!!
  45.  
  46.       3) Create a configuration file, with a name of your choice, or
  47.          modify the supplied CRYPTO.CFG file. A description follows:
  48.  
  49.             **                       Location of system file (See Below)
  50.             SUNRISE-80 BBS           Your BBS Name
  51.             Al                       Sysop's First nameAP
  52.  
  53.             Lawrence                 Sysop's Last Name
  54.  
  55. |-----------------------------------------------------------------------------|
  56. | READ!     1                        CommPort  \ These 2 lines are required   |
  57. | READ!     1                        Node #    / ONLY for GTUSER.BBS          |
  58. |-----------------------------------------------------------------------------|
  59.  
  60.             00000000                 Registration Number
  61.  
  62.     !   #   1                        Maximum # of Calls per day(Plays per day) 
  63.                                      (Sysop gets 99, Registered version ONLY)
  64.  
  65.             50                       Number of Top Score entries.
  66.                                      Minimum = 10, Maximum = 99.
  67.  
  68.         #   NONE                     Drive:\Path\Filename to contain the
  69.                                      Top Score Bulletin or enter NONE
  70.                                      for NO Bulletin creation.
  71.  
  72.         #   NONE                     Drive:\Path\Filename to contain the
  73.                                      Top Score Bulletin (Color) or enter NONE
  74.                                      for NO Bulletin creation.
  75.  
  76.             2                        1 = DO NOT Display ADOPT-A-DOOR Message
  77.                                      2 = Display ADOPT-A-DOOR message
  78.  
  79.         #   2                        Keyboard timeout value in Minutes
  80.  
  81.     !   #   0                        Time Allowed in Door
  82.                                      (Sysop = Time Remaining - REG. VERSION)
  83.  
  84.         #   2                        Number of players that must solve the
  85.                                      Cryptogram before it is changed by
  86.                                      your nightly event.
  87.  
  88.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  89.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  90.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  91.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  92.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  93.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  94.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  95.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  96.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  97.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  98.  
  99.     @   #   XXXX/YYYY                 Blackout Range  From/To
  100.     @   #   XXXX/YYYY                 Blackout Range  From/To
  101.     @   #   XXXX/YYYY                 Blackout Range  From/To
  102.     @   #   XXXX/YYYY                 Blackout Range  From/To
  103.     @   #   XXXX/YYYY                 Blackout Range  From/To
  104.  
  105.           ** = Replace with ONE of the following:
  106.  
  107. C:\PCB\PCBOARD.SYS              <- For PCBoard systems using PCBOARD.SYS only
  108. C:\BBS\CALLINFO.BBS             <- For Wildcat! systems (prior to v3.0)
  109. C:\BBS\USERINFO.DAT             <- For Wildcat! systems using v3.x
  110.                                    (Note:DOOR.SYS must be in SAME directory)
  111. C:\BBS\DOOR.SYS                 <- For ANY systems that support DOOR.SYS
  112. C:\BBS\DORINFOx.DEF             <- For ANY systems that support DORINFOx.DEF
  113. C:\BBS\SFDOORS.DAT              <- For Spitfire systems.
  114. c:\bbs\TRIBBS.SYS               <- For TriBBS system.
  115. C:\BBS\CHAIN.TXT                <- For WWIV systems 
  116. C:\BBS\GTUSER.BBS               <- For GT Power 
  117.                                    * if using this option you must put the
  118.                                      ComPort # on line 5 and the Node # on
  119.                                      line 6 of the configuration file
  120.  
  121.  
  122.  
  123.            # = Requires registration to change to a different value.
  124.            ! = See "Plays Per Day" Below
  125.            @ = See "Blackout Periods" Below
  126.  
  127.                NOTE: There are NO Blank Lines in the Config File!!
  128.  
  129.  
  130.  
  131.  
  132.       4) Create a batch file or modify the CRYPTO file supplied. A
  133.          description of this file follows:
  134.  
  135.             ECHO off
  136.             cd\PCB\DOORS\CRYPTO       Location of CRYPTO files
  137.             CRYPTO CRYPTO.CFG         EXE filename and CFG filename (Name
  138.                                       used in creating file in #3 above)
  139.             CD\PCB
  140.             BOARD
  141.  
  142.  
  143.        5) When running in more than one node, be sure to supply a
  144.           different configuration name for each node (your choice of name).
  145.  
  146.  
  147.                   
  148.                           BLACKOUT PERIODS
  149.                           ________________
  150.  
  151.       Use the Blackout ranges option to define up to 5 time periods during
  152.       which you DO NOT want the Door to be played. If a caller tries to access 
  153.       the Door during the Blackout period, they will be shown a message that
  154.       contains ALL the Blackout periods you have defined, and to try the Door
  155.       at a later time.
  156.  
  157.       Each of the 5 Blackout ranges takes the form of XXXX/YYYY, where
  158.       XXXX=beginning time and YYYY=the ending time. For example, 0930/1230
  159.       means to NOT allow the Door to be played between 9:30am and 12:30pm.
  160.  
  161.       IMPORTANT: - All times must be 4 digits & must follow the XXXX/YYYY format
  162.                  - DO NOT change the XXXX/YYYY entry UNLESS you want to assign
  163.                    a Blackout range.
  164.                  - You MUST use the MILITARY time format. Example: 2030=8:30pm
  165.                    0900=9am, 0030=12:30am, 1700=5pm, etc.
  166.  
  167.  
  168.                           PLAYS Per DAY/DOOR Time
  169.                           _______________________
  170.  
  171.       Plays Per Day and Door Time can be controlled several ways:
  172.  
  173.       (1) You can use the Games Per Day, singular option, in the config
  174.           file above. This option, will affect ALL callers whose Security
  175.           Level is NOT defined in any of the 10 optional Security Level/
  176.           Plays Per Day entries in the config file.
  177.  
  178.       (2) You can use the Door Time, singular option, in the config file
  179.           above. This option, will affect ALL callers whose Security
  180.           Level is NOT defined in any of the 10 optional Security Level/
  181.           Plays Per Day/Door Time entries in the config file.
  182.  
  183.       (3) You can restrict the number of games a specific Security Level
  184.           will be allowed to play per day or REWARD specific Levels with 
  185.           more Plays Per Day. 
  186.  
  187.           Likewise, you can restrict the Play time for a specific Security
  188.           Level or REWARD specific Levels with more Door Time.
  189.  
  190.           These options are handled by the use of the 10 config 
  191.           entries (000=00/00). 
  192.           
  193.           The format of each entry is as follows:
  194.  
  195.           XXX=YY/ZZ  where XXX is the Security Level (must be 3 digits)
  196.                      where =  is a constant and MUST be included
  197.                      where YY is the # of games per day (must be 2 digits)
  198.                      where / is a constant and MUST be included
  199.                      where ZZ is num. minutes per Door entry (must be 2 digits)
  200.           
  201.           If the callers Security Level is NOT defined, his/her Plays Per
  202.           Day and Door Time will be controlled by the values in items
  203.           (1) and (2), above, respectively..
  204.  
  205.           You may define up to 10 Security Levels. All unused entries must
  206.           be defined as   000=00/00
  207.         --------------------------------------------------------------------
  208.           Example: Suppose you had 3 Security Levels defined on your BBS as
  209.           (20=Subscriber, 30=Visiting Sysop, 40=CoSysop, 90=Friend) and you 
  210.           wanted to set Plays Per Day as :     Subscriber=5
  211.                                            Visiting Sysop=2
  212.                                                   CoSysop=3
  213.                                                    Friend=10 
  214.           
  215.           and Door Time as follows:     Subscriber=30 minutes
  216.                                     Visiting Sysop=20 minutes
  217.                                            CoSysop=10 minutes 
  218.                                             Friend=remaining call time
  219.                                
  220.  
  221.           You would set the Individual "Games per Day" config entry to 1 and 
  222.           the individual "Door Time" to 5 minutes (these would be the 
  223.           default number of games and default Time for all Security Levels
  224.           other than 20,30 or 40... make them any number you want). Next you
  225.           would replace 4 of the Security Level entries as :  020=05/30                                               
  226.                                                               030=02/20
  227.                                                               040=03/10
  228.                                                               090=10/0
  229.  
  230.  
  231.                             EVENT PROCESSING
  232.                             ________________
  233.  
  234.       To change the CRYPTOGRAM phrases automatically, you must run the
  235.       CRYPENVT.EXE program, using the same configuration file you use for the
  236.       Door. Place the following in your nightly event batch file and it will 
  237.       check the CFG file to see if the correct number of players have solved 
  238.       the CRYPTOGRAM. If so it will change the CRYPTOGRAM by taking the next 
  239.       available one from the CRYPTO.DAT file, and reset the Hi Score file for
  240.       a new game. 
  241.  
  242.                              CRYPENVT CRYPTO.CFG
  243.  
  244.      NOTE: This option requires that CRYPTOGRAMS be registered!!!
  245.  
  246.  
  247.                               CRYPTOGRAM DATABASE
  248.                               ____________________
  249.  
  250.      The CRYPTOGRAM database (CRYPTO.DAT) can be added to using your favorite 
  251.      text editor. Phrases MUST only contain alphabetic characters (A-Z) and 
  252.      spaces. No other characters will be permitted. The maximum length of any
  253.      phrase is 66.
  254.  
  255.  
  256.  
  257.                         NON-STANDARD COM SUPPORT
  258.                         ________________________
  259.  
  260.       Support for COM 1-4 on the standard IRQ's - COM1/COM3 = IRQ4 and
  261.       COM2/COM4 = IRQ3. If you wish to use a non-standard IRQ, add the IRQ
  262.       number after the configuration filename. Let's assume your Door is
  263.       called FOOBAR and you want to use COM1 and IRQ5. The command line
  264.       passed to your Door would be:
  265.  
  266.                             FOOBAR FOOBAR.CFG /5
  267.  
  268.       The /5 tells FOOBAR to use IRQ5 rather than the standard IRQ4 that is
  269.       normally used with COM1. No /x parameter is needed for the standard
  270.       IRQ's.
  271.  
  272.       As an alternative, you may use an environmental variable on the command
  273.       line. To use the variable (following the example above), place a 
  274.       SET IRQ=5 in the batch file used to bring up your BBS (you would need a 
  275.       different IRQ number for each node). The command line would now look 
  276.       like this: 
  277.  
  278.                           FOOBAR FOOBAR.CFG /%IRQ%
  279.       
  280.       This, in combination with the use of the environmental variables 
  281.       described in the MULTI-NODE SETUP section will allow you to use one 
  282.       batch file and one config file to run this door on all nodes.
  283.  
  284.  
  285.  
  286.  
  287.                            MULTI-NODE SETUP
  288.                            ________________
  289.  
  290.       All Sunrise Doors are Multi-Node capable. Each node must have the 
  291.       ability to access a configuration file which will have its own system 
  292.       file (DORINFOx.DEF, PCBOARD.SYS, DOOR.SYS, etc) defined on the first 
  293.       line. There are 2 ways to accomplish this:
  294.  
  295.       (1) Create a separate configuration file for each node. The only 
  296.           difference between each file would be the location of the system 
  297.           file for that particular node. For example, on my system there are 2
  298.           nodes and the first line of the config files would look like this:
  299.  
  300.                         NODE1:  H:\PCB1\DOOR.SYS
  301.                         NODE2:  H:\PCB2\DOOR.SYS
  302.  
  303.           Thus, if you have a 4 node BBS, you will need 4 configuration files.
  304.  
  305.       (2) Use ONE configuration file for ALL nodes. This Door will recognize 
  306.           the following PCBoard environmental variables:
  307.  
  308.                  PCBDIR    (Directory containing the System file)
  309.                  PCBDRIVE  (Drive containing the System file)
  310.  
  311.           Thus, the first line of the SINGLE configuration file, for this Door
  312.           would look like this:
  313.  
  314.                         %PCBDRIVE%%PCBDIR%\DOOR.SYS
  315.  
  316.       NOTE: This option, as described, assumes that you are running PCBoard 
  317.             14.5a software. The environmental variables are automatically 
  318.             created by the software for each node.
  319.  
  320.             HOWEVER, if you are running other BBS software you should be able
  321.             to set the variables EXACTLY as described below, for EACH node 
  322.             (more than likely in each batch file you use to bring up EACH node):
  323.  
  324.                             PCBDRIVE=C:
  325.                             ^^^^^^^^^
  326.                             PCBDIR=\NODE2
  327.                             ^^^^^^^^
  328.             
  329.             Info with a carat (^) under it, MUST be typed as is. The rest 
  330.             depends on your naming conventions. 
  331.  
  332.             This, in combination with the use of the optional environmental
  333.             variable described in the NON-STANDARD COM SUPPORT section, will
  334.             allow you to use one batch file and one config file to run this 
  335.             door on all nodes.
  336.  
  337.  
  338.  
  339.  
  340.                                ADOPT-A-DOOR
  341.                                ____________
  342.  
  343.     Having been a Sysop for a number of years, I have had my share of problems
  344.     and frustrations getting financial support for my board's upkeep. A fellow
  345.     Sysop left a message on my board, not long ago, about a concept that was
  346.     being used by several boards around the country.
  347.  
  348.     The concept, ADOPT-A-DOOR, allows a caller to register (ADOPT) a door. It
  349.     would be the same as sending in a donation, only this way it is earmarked
  350.     for registering a particular door. In a way, the user feels he/she is
  351.     "getting something in return". As a Door author I have decided to build
  352.     this concept into each of my Door programs. The concept replaces the
  353.     usual message "tell the Sysop to register this Door" we find in most
  354.     doors.
  355.  
  356.     If the Door is unregisterd then a message appears on the opening screen
  357.     to that effect. After finishing or suspending a game, a message screen
  358.     is displayed about the ADOPT-A-DOOR concept. The message also tells the
  359.     caller to contact the Sysop to find out if there is any further details
  360.     to the ADOPT-A-DOOR concept. Some Sysops give extra D/L time, online
  361.     time, etc to callers that ADOPT-A-DOOR.
  362.  
  363.     If the Door has been registered, either by the Sysop or other callers,
  364.     the names of those contributors will be displayed in the closing screen.
  365.  
  366.     NOTE: If you want to display the names of the callers that contributed
  367.           to registering the Door, you must create an ASCII file called
  368.           ADOPT.SYS. You create it with an Editor or Word Processor. Enter
  369.           the name(s) of the contributors (one on each line, maximum of 5
  370.           entries, each a maximum of 30 characters long). This file must be
  371.           saved, in ASCII format, and placed in the Door directory.
  372.  
  373.  
  374.  
  375.                               LEGALITIES
  376.                               __________
  377.  
  378.  
  379.       THIS SOFTWARE AND ACCOMPANYING MATERIALS ARE DISTRIBUTED "AS IS"
  380.       WITHOUT WARRANTY, EXPRESS, IMPLIED OR STATUTORY, INCLUDING BUT NOT
  381.       LIMITED TO ANY IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  382.       FOR A PARTICULAR PURPOSE. IN NO EVENT SHALL ANYONE INVOLVED WITH
  383.       THE CREATION AND PRODUCTION OF THIS PRODUCT BE LIABLE FOR INDIRECT,
  384.       SPECIAL, OR CONSEQUENTIAL DAMAGES, ARISING OUT OF ANY USE THEREOF
  385.       OR BREACH OF ANY WARRANTY.
  386.  
  387.  
  388.  
  389.  
  390.  
  391.                              DISTRIBUTION
  392.                              ____________
  393.  
  394.    You may make this file available for downloading from your BBS or you may
  395.    upload it to any BBS of your choice, provided that you do not make any
  396.    changes to the contents of the archive (ZIP file). The archive and its
  397.    individual contents may not be used by any service that charges any money
  398.    whatsoever, without the written permission of the author.
  399.  
  400.  
  401.  
  402.  
  403.  
  404.                              REGISTRATION
  405.                              ____________
  406.  
  407.    Registration and the subsequent insertion of the registration number into
  408.    your configuation file, allows for the display of your BBS name on the
  409.    opening and closing screen as well as the reduction of a delay built into
  410.    the opening screen display along with the ability to change certain
  411.    values in the configuration file.
  412.  
  413.    To register your copy of CRYPTO, please fill out the registration form
  414.    (REGISTER.FRM) and mail it along with the registration fee to
  415.    the name and address on the form.
  416.  
  417.    Be sure to use the proper upper/lower case when filling in your name and
  418.    BBS name, as they MUST match the way you entered them in the configuration
  419.    file.             ^^^^
  420.  
  421.    Based upon information supplied on the registration form, I will pre-
  422.    register you on my BBS. You will then be able to call SUNRISE-80 and pick
  423.    up your registration number.
  424.  
  425.  
  426.  
  427.                                  MISC
  428.                                  ____
  429.  
  430.    The latest version of CRYPTOGRAMS and other fine SUNRISE DOOR programs
  431.    are always available for download from SUNRISE-80 BBS.
  432.  
  433.    Remember, should you have any problems, questions or suggestions, be sure
  434.    to drop me a message on Sunrise-80 or in the RIME network (BBS_Doors, 
  435.    PCBHints, SYSops) or on SMARTNET (SN_Sysops).
  436.